# Slot 4 Menu 20 − EtherNet/IP Setup

Mode: Regeneration

The Ethernet interface supports the EtherNet/IP protocol and conforms to the EtherNet/IP adaptation of the Common Industrial Protocol (CIP) Specification. This is the same upper-layer protocol and object model as used in DeviceNet.

The Ethernet interface will operate as a slave device and the following functionality is supported.

- Variable length input assembly object (instance 100)
- Variable length output assembly object (instance 101)
- Maximum assembly object size of 128 bytes (32 parameters)
- Explicit (non-cyclic) access to parameters
- A.C. drive profiles
- Management of consistent data transfer between the Ethernet interface and user programs.
- Configuration via parameters

Parameter Update Rate

Parameters are exchange over the network. The value exchanged with the network must be exchanged with the drive or option parameter. The rate of data exchange differs for drive/option destinations.

The diagram below depicts the update cycles used within the Ethernet interface. CIP assembly mappings being exchanged with the drive will be updated at the background task rate. This rate (Background cycles per second (09.008)) varies with the load on the Ethernet interface; Easy Mode data exchange also takes place in the background task.

Parameter | 4.20.001 Enable EtherNet/IP
--- | ---
Short description | Set to enable the EtherNet/IP interface
Minimum | 0 | Maximum | 1
Default | 1 | Units |
Type | 1 Bit User Save | Update Rate | Background read
Display Format | Standard | Decimal Places | 0
Coding | RW, BU

This parameter is used to enable or disable EtherNet/IP slave functionality.

Parameter | 4.20.002 Reset
--- | ---
Short description | Set to reset the interface
Minimum | 0 | Maximum | 1
Default | 0 | Units |
Type | 1 Bit Volatile | Update Rate | Background read; written to 0 on initialisation
Display Format | Standard | Decimal Places | 0
Coding | RW, NC

This parameter is used to perform a warm reset of the protocol interface. When set and the protocol has reset, the parameter will be reset to zero (Off).

Parameter | 4.20.003 Default
--- | ---
Short description | Set to default the protocol interface
Minimum | 0 | Maximum | 1
Default | 0 | Units |
Type | 1 Bit Volatile | Update Rate | On module reset, protocol interface reset or protocol enable
Display Format | Standard | Decimal Places | 0
Coding | RW, NC

This parameter allows the protocol to be defaulted to factory settings. This includes all of the protocol features, configuration, mappings and stored objects.

Parameter | 4.20.004 Configuration error
--- | ---
Short description | Displays the EtherNet/IP configuration error
Minimum | 0 | Maximum | 8
Default |  | Units |
Type | 8 Bit Volatile | Update Rate | Background
Display Format | Standard | Decimal Places | 0
Coding | RO, TE, ND, NC, PT, BU

Value | Text | Description
0 | No error | No error
1 | RPI event dst | RPI timeout event desination not valid
2 | RPI event type | RPI timeout event type not valid
3 | IDLE event dst | PLC IDLE event desination not valid
4 | IDLE event type | PLC IDLE event type not valid
5 | Input mapping | Output mapping parameter not valid
6 | Output mapping | Output mapping parameter not valid
7 | In cons trig pr | Input consistency trigger parameter not valid
8 | Out cons trig pr | Output consistency trigger parameter not valid

This parameter is used to display the error code if an EtherNet/IP configuration error occurs.

Parameter | 4.20.007 Cyclic data transfers per second
--- | ---
Short description | Showing the EIP cyclic data transfer rate
Minimum | 0 | Maximum | 65535
Default |  | Units | Messages/s
Type | 16 Bit Volatile | Update Rate | Background
Display Format | Standard | Decimal Places | 0
Coding | RO, ND, NC, PT, BU

This parameter shows the EtherNet/IP cyclic data transfer rate.

Parameter | 4.20.011 RPI timeout action
--- | ---
Short description | Defines the action when an RPI timeout occurs
Minimum | 0 | Maximum | 4
Default | 3 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | Trip | Trip drive with Slx.Er and sub-trip code
1 | Send flt values | Send configured fault values to the output parameters
2 | Clear output | PLC output parameters will have their values set to zero
3 | Hold last | Hold the last value in output parameters
4 | No Action | No action with output parameters

This timeout is defined by the EtherNet/IP protocol and is configured in the PLC master. The interface will monitor the data traffic and if data is not received within the specified time, it will perform the requested action. This indicates that the interface has detected that the cyclic data communication has been interrupted.

Trip
On an RPI timeout the interface will cause a slot trip with sub trip value 101 (EtherNet/IP RPI Timeout).

Send Fault Values
On an RPI timeout the interface will not trip the drive. It will write the values specified in Fault Values menu (23) to the PLC output mappings for the assembly object 101 if active.

Clear Output
On an RPI timeout the interface will not trip the drive. It will write all PLC output mappings for the assembly object 101 if active to zero.

Hold Last
On an RPI timeout the interface will not trip the drive. The last value received will be maintained.

No Action
On an RPI timeout the interface will not trip the drive. The last value received will be maintained.

Parameter | 4.20.012 RPI timeout event destination
--- | ---
Short description | Defines the destination for the RPI timeout event
Minimum | 0 | Maximum | 4
Default | 0 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | This slot | Trigger event in this slot
1 | Slot 1 | Trigger event in slot 1
2 | Slot 2 | Trigger event in slot 2
3 | Slot 3 | Trigger event in slot 3
4 | Slot 4 | Trigger event in slot 4

This parameter defines the destination slot to trigger the event upon an RPI timeout.

<< This feature is not currently supported >>

Parameter | 4.20.013 RPI timeout event type
--- | ---
Short description | Sets the event to trigger on RPI timeout
Minimum | 0 | Maximum | 5
Default | 0 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | No event | No event
1 | Trigger Event | Trigger module Event
2 | Trigger Event 1 | Trigger module Event 1
3 | Trigger Event 2 | Trigger module Event 2
4 | Trigger Event 3 | Trigger module Event 3
5 | Trigger Event 4 | Trigger module Event 4

Defines the event to trigger in the specified destination (RPI timeout event destination (4.20.012)) upon an RPI timeout

Parameter | 4.20.015 PLC idle action
--- | ---
Short description | Defines the action for a PLC idle event
Minimum | 0 | Maximum | 4
Default | 4 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | Trip | Trip drive with Slx.Er and sub-trip code
1 | Send flt values | Send configured fault values to the output parameters
2 | Clear output | PLC output parameters will have their values set to zero
3 | Hold last | Hold the last value in output parameters
4 | No Action | No action with output parameters

This parameter defines the action to be taken upon a PLC idle event.

Parameter | 4.20.016 PLC idle event destination
--- | ---
Short description | Defines the destination for a PLC idle event
Minimum | 0 | Maximum | 4
Default | 0 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | This slot | Trigger event in this slot
1 | Slot 1 | Trigger event in slot 1
2 | Slot 2 | Trigger event in slot 2
3 | Slot 3 | Trigger event in slot 3
4 | Slot 4 | Trigger event in slot 4

This parameter defines the destination slot to trigger the event upon a PLC idle event.

<< This feature is not currently supported >>

Parameter | 4.20.017 PLC idle event type
--- | ---
Short description | Sets the event to trigger on PLC idle
Minimum | 0 | Maximum | 5
Default | 0 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | No event | No event
1 | Trigger Event | Trigger module Event
2 | Trigger Event 1 | Trigger module Event 1
3 | Trigger Event 2 | Trigger module Event 2
4 | Trigger Event 3 | Trigger module Event 3
5 | Trigger Event 4 | Trigger module Event 4

Defines the event to trigger in the specified destination (PLC idle event destination (4.20.016)) upon a PLC idle event.

Parameter | 4.20.018 Active input assembly object
--- | ---
Short description | Sets and displays the active input assembly object
Minimum | 0 | Maximum | 4
Default |  | Units |
Type | 8 Bit Volatile | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RO, TE, ND, NC, PT, BU

Value | Text | Description
0 | 100-PrimaryI | Primary input (100)
1 | 70-BscSpdCtrlI | Basic speed control input (70)
2 | 71-ExtSpdCtrlI | Extended speed control input (71)
3 | 72-SpdTqCtrlI | Speed and torque control input (72)
4 | 73-ExtSpdTqCtrlI | Extended speed and torque control input (73)

This parameter defines and shows the required input assembly object.

Parameter | 4.20.019 Active output assembly object
--- | ---
Short description | Sets and displays the active ouput assembly object
Minimum | 0 | Maximum | 4
Default |  | Units |
Type | 8 Bit Volatile | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RO, TE, ND, NC, PT, BU

Value | Text | Description
0 | 101-PrimaryO | Primary output (101)
1 | 20-BscSpdCtrlO | Basic speed control output (20)
2 | 21-ExtSpdCtrlO | Extended speed control output (21)
3 | 22-SpdTqCtrlO | Speed and torque control output (22)
4 | 23-ExtSpdTqCtrlO | Extended speed and torque control output (23)

This parameter defines and shows the required output assembly object.

Parameter | 4.20.020 Input assembly object size
--- | ---
Short description | Defines the size of the input assembly object
Minimum | 4 | Maximum | 128
Default | 8 | Units | Bytes
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, BU

This parameter defines the size of the input assembly object (100).

Parameter | 4.20.021 Output assembly object size
--- | ---
Short description | Defines the size of the output assembly object
Minimum | 4 | Maximum | 128
Default | 8 | Units | Bytes
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, BU

This parameter defines the size of the output assembly object (101).

Parameter | 4.20.024 Input assembly object process time
--- | ---
Short description | Displays the input assembly object process time
Minimum | 0 | Maximum | 65535
Default |  | Units | ms
Type | 16 Bit Volatile | Update Rate | Background
Display Format | Standard | Decimal Places | 0
Coding | RO, ND, NC, PT, BU

This is the time between getting the input value from the master and it being sent successfully to the drive.

Parameter | 4.20.025 Output assembly object process time
--- | ---
Short description | Displays the output assembly object process time
Minimum | 0 | Maximum | 65535
Default |  | Units | ms
Type | 16 Bit Volatile | Update Rate | Background
Display Format | Standard | Decimal Places | 0
Coding | RO, ND, NC, PT, BU

This is the time between getting the output value from the drive and it being sent successfully to the master.

Parameter | 4.20.026 Input assembly object consistency enable
--- | ---
Short description | Enables or disables consistency on the input assembly object
Minimum | 0 | Maximum | 1
Default | 0 | Units |
Type | 1 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW

This parameter allows for enabling and disabling input assembly object consistency.

Under normal conditions, cyclic data is sampled and transmitted at the Requested Packet Interval (RPI). However, if an option module was in the process of modifying the mapped parameters while these parameters were being sampled, then the data transmitted across the network may not be consistent across the entire assembly object. If read consistency is enabled (and a trigger parameter specified inInput assembly object consistency trigger parameter (4.20.027)) then data will only be sampled when the trigger parameter Input assembly object consistency trigger parameter (4.20.027) contains a non-zero value. This trigger parameter will then be set to zero after the data has been sampled.

It is therefore possible, by controlling the trigger parameters, that a user program in the drive or option module can ensure that the values in the cyclic data parameters are not sampled until all values are updated. Whether consistency is enabled or not, data will always be consistent for an individual parameter, i.e. all 4 bytes of a 32 bit value will be consistent.

Parameter | 4.20.027 Input assembly object consistency trigger parameter
--- | ---
Short description | Sets the trigger parameter for input assembly object consistency
Minimum | 0 | Maximum | 499999
Default | 0 | Units |
Type | 32 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Slot Menu Parameter | Decimal Places | 0
Coding | RW, BU

This parameter specifies the parameter to use for triggering input assembly object consistency. See Input assembly object consistency enable (4.20.026) for more information on consistency.

Parameter | 4.20.028 Output assembly object consistency enable
--- | ---
Short description | Enables or disables consistency on the output assembly object
Minimum | 0 | Maximum | 1
Default | 0 | Units |
Type | 1 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW

This parameter allows for enabling and disabling output assembly object consistency.

Sampling of data can be controlled using consistency by enabling this parameter and setting a trigger parameter (Output assembly object consistency trigger parameter (4.20.029)).

Consistency enabled

When output assembly object consistency is enabled, the value in the output assembly object consistency trigger parameter (Output assembly object consistency trigger parameter (4.20.029)) is checked at the beginning of the writing routine. If it is zero then data is written to the cyclic data destination parameters and the trigger parameter is set to 1. If the value is non-zero then new data is discarded.

Consistency disabled

When output assembly object consistency is disabled, new data is written to the cyclic data destination parameters just after it has been received.

Note : If write consistency is enabled, then at reset or at power-up, the value in the trigger parameter is set to zero.

Parameter | 4.20.029 Output assembly object consistency trigger parameter
--- | ---
Short description | Sets the trigger parameter for input assembly object consistency
Minimum | 0 | Maximum | 499999
Default | 0 | Units |
Type | 32 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Slot Menu Parameter | Decimal Places | 0
Coding | RW, BU

This parameter specifies the parameter to use for triggering output assembly object consistency. See Output assembly object consistency enable (4.20.028) for more information on consistency.

Parameter | 4.20.030 Custom Vendor ID
--- | ---
Short description | Custom Defined Vendor ID
Minimum | 0 | Maximum | 1
Default | 0 | Units |
Type | 8 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, TE, BU

Value | Text | Description
0 | 257 - CT | EtherNet/IP interface
1 | 553 - CT AMERICA | EtherNet/IP America interface

This parameter defines the customised vendor ID.

Parameter | 4.20.031 Custom product code
--- | ---
Short description | Sets and displays the custom product code
Minimum | 0 | Maximum | 65535
Default | 0 | Units |
Type | 16 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, BU

This parameter defines a custom product type value which is used to identify the product on the network.

Parameter | 4.20.032 Custom product revision code
--- | ---
Short description | Sets and displays the custom product revision code
Minimum | 0 | Maximum | 65535
Default | 0 | Units |
Type | 16 Bit User Save | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RW, BU

This parameter defines a custom product revision value which is used to identify the product on the network.

Parameter | 4.20.033 Actual Product Code
--- | ---
Short description | Displays the actual product code
Minimum | 0 | Maximum | 65535
Default |  | Units |
Type | 16 Bit Volatile | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RO, ND, NC, PT, BU

This parameter defines the actual product code.

Parameter | 4.20.034 Actual Product Revision
--- | ---
Short description | Display the actual product revision
Minimum | 0 | Maximum | 65535
Default |  | Units |
Type | 16 Bit Volatile | Update Rate | Module reset, EtherNet/IP interface reset or EtherNet/IP interface enable
Display Format | Standard | Decimal Places | 0
Coding | RO, ND, NC, PT, BU

This parameter defines the actual revision number.

Parameter | 4.20.040 Type of Motor 1
--- | ---
Short description | The type of motor 1
Minimum | 0 | Maximum | 4
Default | 2 | Units |
Type | 8 Bit User Save | Update Rate | Reset
Display Format | Standard | Decimal Places | 0
Coding | RO, TE, PT, BU

Value | Text | Description
0 | 2-FC DC | FC DC Motor
1 | 6-WRI | Wound Rotor Induction Motor
2 | 7-SCI | Squirrel Cage Induction Motor
3 | 9-Sin PM BL | Sinusoidal PM BL Motor
4 | 10-Trap PM BL | Trapezoidal PM BL Motor

This parameter defines the type of motor 1

Parameter | 4.20.041 Type of Motor 2
--- | ---
Short description | The type of motor 2
Minimum | 0 | Maximum | 4
Default | 2 | Units |
Type | 8 Bit User Save | Update Rate | Reset
Display Format | Standard | Decimal Places | 0
Coding | RO, TE, PT, BU

Value | Text | Description
0 | 2-FC DC | FC DC Motor
1 | 6-WRI | Wound Rotor Induction Motor
2 | 7-SCI | Squirrel Cage Induction Motor
3 | 9-Sin PM BL | Sinusoidal PM BL Motor
4 | 10-Trap PM BL | Trapezoidal PM BL Motor

This parameter defines the type of motor 2